Snapservice WeeklyRetention

The Snapservice WeeklyRetention schema contains properties that describe the weekly retention settings for a given protection group with Snapservice ReplicationPolicy enabled.

This schema was added in vSphere API 9.1.0.0.

JSON Example

{
    "hour": 0,
    "day_of_week": "string",
    "retention": {
        "unit": "string",
        "duration": 0
    }
}

integer As int64 As int64

hour

Required

Specifies the hour of the day, around which a replica snapshot is to be retained. The actual time when the snapshot is chosen might not be accurate since it depends on replica snapshots to be available as per the short term retention. Its value scope is [0, 1, 2, ..., 23]

This property was added in vSphere API 9.1.0.0.

string

day_of_week

Required

Specifies the day of week at which a replica snapshot is selected for long term retention.

For more information see: Snapservice DayOfWeek.

This property was added in vSphere API 9.1.0.0.

retention

Required

Total retention period for the snapshots.

This property was added in vSphere API 9.1.0.0.